Help/Extending and Customizing SC/Modifying_Standalones.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="949.46">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Lucida Grande}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Lucida Grande; min-height: 15.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Lucida Grande}
  13 span.s1 {color: #0000ff}
  14 span.Apple-tab-span {white-space:pre}
  15 </style>
  16 </head>
  17 <body>
  18 <p class="p1"><b>Modifying the Standalone Template for your own App</b></p>
  19 <p class="p2"><br></p>
  20 <p class="p3">If you do not have or use Apple Developer tools, the easiest way to create an SC-based<span class="Apple-converted-space"> </span></p>
  21 <p class="p3">standalone application is to modify an existing SC standalone:<span class="Apple-converted-space"> </span></p>
  22 <p class="p2"><br></p>
  23 <p class="p3">1 - Obtain the compiled '<b>Standalone Template.app</b>' for the desired version of SC3,<span class="Apple-converted-space"> </span></p>
  24 <p class="p3"><span class="Apple-tab-span">     </span>e.g. SC3.3.1, and make a copy of it for modification.</p>
  25 <p class="p2"><span class="Apple-tab-span">     </span></p>
  26 <p class="p3">2 - Renaming<span class="Apple-converted-space"> </span></p>
  27 <p class="p3"><span class="Apple-tab-span">     </span>* In the Finder, rename the copy of '<b>Standalone Template.app</b>' to e.g. <b>YourApp.app</b></p>
  28 <p class="p3"><span class="Apple-tab-span">     </span>* Alt-click on YourApp.app, and select 'Show package contents':</p>
  29 <p class="p3"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>Ths opens the folder inside the app.</p>
  30 <p class="p3"><span class="Apple-tab-span">     </span>* Open the file Contents/Info.plist (with PropertyListEditor if you have it, or any text editor),<span class="Apple-converted-space"> </span></p>
  31 <p class="p3"><span class="Apple-tab-span">     </span>* in the section:<span class="Apple-converted-space"> </span></p>
  32 <p class="p3"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>...</p>
  33 <p class="p3"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>&lt;key&gt;CFBundleName&lt;/key&gt;</p>
  34 <p class="p3"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>&lt;string&gt;Standalone Template&lt;/string&gt;</p>
  35 <p class="p3"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>...</p>
  36 <p class="p3"><span class="Apple-tab-span">     </span>replace '<b>Standalone Template</b>' with <b>YourApp</b></p>
  37 <p class="p2"><br></p>
  38 <p class="p3"><span class="Apple-tab-span">     </span>For safety, keep<span class="Apple-converted-space">  </span>a copy of the file Info.plist. around.</p>
  39 <p class="p2"><br></p>
  40 <p class="p3">2 - Credits</p>
  41 <p class="p3"><span class="Apple-tab-span">     </span>In Resources/English.lproj/Credits.rtf, add credits for all contributors to YourApp.</p>
  42 <p class="p2"><br></p>
  43 <p class="p3">3 - The top Help file</p>
  44 <p class="p3"><span class="Apple-tab-span">     </span>Edit Resources/Help/Help.html to inform users about YourApp.</p>
  45 <p class="p2"><span class="Apple-tab-span">     </span></p>
  46 <p class="p3">4 - Adding resources, extensions, etc etc</p>
  47 <p class="p3"><span class="Apple-tab-span">     </span>Put any soundfiles you intend to use in /Contents/Resources/sounds</p>
  48 <p class="p3"><span class="Apple-tab-span">     </span>Put any extra UGen plugin libraries your app requires in (e.g. Kloink.scx) in Resources/plugins</p>
  49 <p class="p3"><span class="Apple-tab-span">     </span>Put any classes for YourApp in Resources/SCClassLibrary</p>
  50 <p class="p2"><br></p>
  51 <p class="p3">5 - Modifying the startup file<span class="Apple-converted-space"> </span></p>
  52 <p class="p3"><span class="Apple-tab-span">     </span>in Resources/SCClassLibrary/, modify the file <b>modifyStartup.sc</b></p>
  53 <p class="p3"><span class="Apple-tab-span">     </span>to do anything your app needs, such as boot the server.</p>
  54 <p class="p3"><span class="Apple-tab-span">     </span>Then, call the class(es) and/or execute the script(s) that start(s) YourApp.</p>
  55 <p class="p3"><span class="Apple-tab-span">     </span>See the section <b>Adding your own behavior</b> in <a href="Creating-Standalone-Applications.html"><span class="s1">Creating-Standalone-Applications</span></a><span class="s1">!</span></p>
  56 <p class="p2"><br></p>
  57 <p class="p3">6 - Start <b>YourApp</b> and test that it works. Adjusting scripts will usually require<span class="Apple-converted-space"> </span></p>
  58 <p class="p3"><span class="Apple-tab-span">     </span>modifications of file paths, and you may have forgotten classes!<span class="Apple-converted-space"> </span></p>
  59 <p class="p3"><span class="Apple-tab-span">     </span>You can recompile, edit scripts, add classes, as in SC3 itself.</p>
  60 <p class="p2"><span class="Apple-tab-span">     </span></p>
  61 <p class="p3">7 - When your app works as desired - <b>Share and Enjoy!</b></p>
  62 <p class="p2"><br></p>
  63 </body>
  64 </html>